/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the examples of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef DIAGRAMITEM_H
#define DIAGRAMITEM_H

#include <QGraphicsPixmapItem>
#include <QList>
#include "diagramtextitem.hpp"

QT_BEGIN_NAMESPACE
class QPixmap;
class QGraphicsItem;
class QGraphicsScene;
class QTextEdit;
class QGraphicsSceneMouseEvent;
class QMenu;
class QGraphicsSceneContextMenuEvent;
class QPainter;
class QStyleOptionGraphicsItem;
class QWidget;
class QPolygonF;
QT_END_NAMESPACE

class Arrow;

class DiagramItem : public QGraphicsPolygonItem
{
public:
    enum { Type = UserType + 15 };
    enum DiagramType { Step, Conditional, StartEnd, Io, Call, Label };
    /**
    * @brief Constructor for DiagramItem
    *
    * @fn DiagramItem(DiagramType diagramType, QString text, int width, int height, int x, int y, QGraphicsItem *parent = 0, QGraphicsScene *scene = 0);
    * @param diagramType
    * @param text
    * @param width
    * @param height
    * @param x
    * @param y
    * @param parent
    * @param scene
    */
    DiagramItem(DiagramType diagramType, QString text, int width, int height, int x, int y, int column, QGraphicsItem *parent = 0, QGraphicsScene *scene = 0);

    /**
    * @brief Removes an arrow of this item
    *
    * @fn void removeArrow(Arrow *arrow)
    * @param arrow
    */
    void removeArrow(Arrow *arrow);

    /**
    * @brief Removes all arrows of this item
    *
    * @fn void removeArrows()
    */
    void removeArrows();

    /**
    * @brief Returns the type of this item
    *
    * @fn DiagramType diagramType() const
    */
    DiagramType diagramType() const
        { return myDiagramType; }

    /**
    * Returns the polygon of this item
    *
    * @fn QPolygonF polygon() const
    */
    QPolygonF polygon() const
        { return myPolygon; }

    /**
    * @brief Checks if this item contains the given arrow
    *
    * @fn bool containsArrow(Arrow *arrow)
    * @param arrow
    * @return bool
    */
    bool containsArrow(Arrow *arrow);

    /**
    * @brief Returns the diagramtextitem as pointer
    *
    * @fn DiagramTextItem *getDiagramTextItem() const
    * @return DiagramTextItem
    */
    DiagramTextItem *getDiagramTextItem() const;

    /**
    * @brief Adds the given arrow to this item
    *
    * @fn void addArrow(Arrow *arrow)
    * @param arrow
    */
    void addArrow(Arrow *arrow);

    /**
    * @brief Returns the Arrows of this DiagramItem
    *
    * @fn QList<Arrow *> getArrows()
    * @return QList<Arrow *>
    */
    QList<Arrow *> getArrows();

    /**
    * @brief Returns if the column is true or false. Needed to choose the arrow color.
    *
    * @fn bool getColumn()
    * @return bool
    */
    int getColumn();

    /**
    * @brief Returns the image of this item as QPixmap
    *
    * @fn QPixmap image() const
    * @return QPixmap
    */
    QPixmap image() const;

    /**
    * @brief Returns the type of this item
    *
    * @fn int type() const
    */
    int type() const
        { return Type;}

protected:
    /**
    * @brief Updates the arrows after the item has changed
    *
    * @fn QVariant itemChange(GraphicsItemChange change, const QVariant &value)
    * @param change
    * @param value
    * @return QVariant
    */
    QVariant itemChange(GraphicsItemChange change, const QVariant &value);

private:
    DiagramType myDiagramType;
    DiagramTextItem *diagramTextItem;
    int column;
    QPolygonF myPolygon;
    QList<DiagramItem*> previousItems;
    QList<Arrow *> arrows;
};

#endif
